// Copyright 2017 The Gop Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

/*
Package gop is a project manangement tool for building your golang applications out of global GOPATH.
In fact gop will keep both global GOPATH and every project GOPATH. But that means your project will
not go-getable. Of course, GOP itself is go-getable. GOP copy all denpendencies from global GOPATH
to your project's src/vendor directory and all application's sources are also in src directory.

A normal process using gop is below:

	git clone xxx@mydata.com:bac/aaa.git
	cd aaa
	gop ensure -g
	gop build
	gop test

Features

1. GOPATH compatible

2. Multiple build targets support

3. Put your projects out of global GOPATH

Installation

Please ensure you have installed the go command, GOP will invoke it on building or testing

	go get github.com/lunny/gop

Directory structure

Every project should have a GOPATH directory structure and put a gop.yml int the root directory.
This is an example project's directory tree.

	<project root>
	├── gop.yml
	├── bin
	├── doc
	└── src
		├── main
		│   └── main.go
		├── models
		│   └── models.go
		├── routes
		│   └── routes.go
		└── vendor
			└── github.com
				├── go-xorm
				│   ├── builder
				│   ├── core
				│   └── xorm
				└── lunny
					├── log
					└── tango

Gop.yml

Gop will recognize a gop project which has gop.yml. The file is also a project configuration file.
Below is an example. If you didn't define any target, the default target is src/main and the target
name is the project name.

	targets:
	- name: myproject1
		dir: main
		assets:
			- templates
			- public
			- config.ini
			- key.pem
			- cert.pem
	- name: myproject2
		dir: web
		assets:
			- templates
			- public
			- config.ini

Command

1. init

Create the default directory structure tree.

	gop init

2. ensure

Automatically copy dependencies from $GOPATH to local project directory. -g will let you automatically
call go get <package> when the package is missing on GOPATH. -u will always go get <package> on all the
dependencies and copy them to vendor.

	gop ensure [-g|-u] [target_name]

3. status

List all dependencies of this project and show the status.

	gop status [target_name]

4. add

Add one or more packages to this project.

	gop add <package1> <package2>

5. update

Update one or more packages to this project. All missing dependent packages will also be added.
-f will update exists dependent packages.

	gop update [-f] <package1> <package2>

6. rm

Remove one or more packages from this project.

	gop rm <package1> <package2>

7. build

Run go build on the src directory.

	gop build [target_name]

8. run

Run go run on the src directory. -w will monitor the go source code changes and
automatically build and run again.

	gop run [-w] [target_name]

9. test

Run go test on the src directory.

	gop test [target_name]

10. release

Run go release on the src directory.

	gop release [target_name]

*/
package main
